home *** CD-ROM | disk | FTP | other *** search
/ CD Actual 85 / CD Actual 85 Febrero 2004.iso / Experto / Apache / apache_2.0.48-win32-x86-no_ssl.msi / Data.Cab / F251777_apr_thread_mutex.h < prev    next >
Encoding:
C/C++ Source or Header  |  2003-03-05  |  5.7 KB  |  149 lines
  1. /* ====================================================================
  2.  * The Apache Software License, Version 1.1
  3.  *
  4.  * Copyright (c) 2000-2003 The Apache Software Foundation.  All rights
  5.  * reserved.
  6.  *
  7.  * Redistribution and use in source and binary forms, with or without
  8.  * modification, are permitted provided that the following conditions
  9.  * are met:
  10.  *
  11.  * 1. Redistributions of source code must retain the above copyright
  12.  *    notice, this list of conditions and the following disclaimer.
  13.  *
  14.  * 2. Redistributions in binary form must reproduce the above copyright
  15.  *    notice, this list of conditions and the following disclaimer in
  16.  *    the documentation and/or other materials provided with the
  17.  *    distribution.
  18.  *
  19.  * 3. The end-user documentation included with the redistribution,
  20.  *    if any, must include the following acknowledgment:
  21.  *       "This product includes software developed by the
  22.  *        Apache Software Foundation (http://www.apache.org/)."
  23.  *    Alternately, this acknowledgment may appear in the software itself,
  24.  *    if and wherever such third-party acknowledgments normally appear.
  25.  *
  26.  * 4. The names "Apache" and "Apache Software Foundation" must
  27.  *    not be used to endorse or promote products derived from this
  28.  *    software without prior written permission. For written
  29.  *    permission, please contact apache@apache.org.
  30.  *
  31.  * 5. Products derived from this software may not be called "Apache",
  32.  *    nor may "Apache" appear in their name, without prior written
  33.  *    permission of the Apache Software Foundation.
  34.  *
  35.  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
  36.  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  37.  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  38.  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
  39.  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  40.  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  41.  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  42.  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  43.  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  44.  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  45.  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  46.  * SUCH DAMAGE.
  47.  * ====================================================================
  48.  *
  49.  * This software consists of voluntary contributions made by many
  50.  * individuals on behalf of the Apache Software Foundation.  For more
  51.  * information on the Apache Software Foundation, please see
  52.  * <http://www.apache.org/>.
  53.  */
  54.  
  55. #ifndef APR_THREAD_MUTEX_H
  56. #define APR_THREAD_MUTEX_H
  57.  
  58. /**
  59.  * @file apr_thread_mutex.h
  60.  * @brief APR Thread Mutex Routines
  61.  */
  62.  
  63. #include "apr.h"
  64. #include "apr_errno.h"
  65.  
  66. #ifdef __cplusplus
  67. extern "C" {
  68. #endif /* __cplusplus */
  69.  
  70. #if APR_HAS_THREADS || defined(DOXYGEN)
  71.  
  72. /**
  73.  * @defgroup apr_thread_mutex Thread Mutex Routines
  74.  * @ingroup APR 
  75.  * @{
  76.  */
  77.  
  78. /** Opaque thread-local mutex structure */
  79. typedef struct apr_thread_mutex_t apr_thread_mutex_t;
  80.  
  81. #define APR_THREAD_MUTEX_DEFAULT  0x0   /**< platform-optimal lock behavior */
  82. #define APR_THREAD_MUTEX_NESTED   0x1   /**< enable nested (recursive) locks */
  83. #define APR_THREAD_MUTEX_UNNESTED 0x2   /**< disable nested locks */
  84.  
  85. /* Delayed the include to avoid a circular reference */
  86. #include "apr_pools.h"
  87.  
  88. /**
  89.  * Create and initialize a mutex that can be used to synchronize threads.
  90.  * @param mutex the memory address where the newly created mutex will be
  91.  *        stored.
  92.  * @param flags Or'ed value of:
  93.  * <PRE>
  94.  *           APR_THREAD_MUTEX_DEFAULT   platform-optimal lock behavior.
  95.  *           APR_THREAD_MUTEX_NESTED    enable nested (recursive) locks.
  96.  *           APR_THREAD_MUTEX_UNNESTED  disable nested locks (non-recursive).
  97.  * </PRE>
  98.  * @param pool the pool from which to allocate the mutex.
  99.  * @warning Be cautious in using APR_THREAD_MUTEX_DEFAULT.  While this is the
  100.  * most optimial mutex based on a given platform's performance charateristics,
  101.  * it will behave as either a nested or an unnested lock.
  102.  */
  103. APR_DECLARE(apr_status_t) apr_thread_mutex_create(apr_thread_mutex_t **mutex,
  104.                                                   unsigned int flags,
  105.                                                   apr_pool_t *pool);
  106. /**
  107.  * Acquire the lock for the given mutex. If the mutex is already locked,
  108.  * the current thread will be put to sleep until the lock becomes available.
  109.  * @param mutex the mutex on which to acquire the lock.
  110.  */
  111. APR_DECLARE(apr_status_t) apr_thread_mutex_lock(apr_thread_mutex_t *mutex);
  112.  
  113. /**
  114.  * Attempt to acquire the lock for the given mutex. If the mutex has already
  115.  * been acquired, the call returns immediately with APR_EBUSY. Note: it
  116.  * is important that the APR_STATUS_IS_EBUSY(s) macro be used to determine
  117.  * if the return value was APR_EBUSY, for portability reasons.
  118.  * @param mutex the mutex on which to attempt the lock acquiring.
  119.  */
  120. APR_DECLARE(apr_status_t) apr_thread_mutex_trylock(apr_thread_mutex_t *mutex);
  121.  
  122. /**
  123.  * Release the lock for the given mutex.
  124.  * @param mutex the mutex from which to release the lock.
  125.  */
  126. APR_DECLARE(apr_status_t) apr_thread_mutex_unlock(apr_thread_mutex_t *mutex);
  127.  
  128. /**
  129.  * Destroy the mutex and free the memory associated with the lock.
  130.  * @param mutex the mutex to destroy.
  131.  */
  132. APR_DECLARE(apr_status_t) apr_thread_mutex_destroy(apr_thread_mutex_t *mutex);
  133.  
  134. /**
  135.  * Get the pool used by this thread_mutex.
  136.  * @return apr_pool_t the pool
  137.  */
  138. APR_POOL_DECLARE_ACCESSOR(thread_mutex);
  139.  
  140. #endif /* APR_HAS_THREADS */
  141.  
  142. /** @} */
  143.  
  144. #ifdef __cplusplus
  145. }
  146. #endif
  147.  
  148. #endif  /* ! APR_THREAD_MUTEX_H */
  149.